home *** CD-ROM | disk | FTP | other *** search
/ IRIX Base Documentation 2002 November / SGI IRIX Base Documentation 2002 November.iso / usr / share / catman / p_man / cat3 / librw / RWTPtrHashTableIterator.z / RWTPtrHashTableIterator
Encoding:
Text File  |  2002-10-03  |  5.1 KB  |  133 lines
  1.  
  2.  
  3.  
  4. RRRRWWWWTTTTPPPPttttrrrrHHHHaaaasssshhhhTTTTaaaabbbblllleeeeIIIItttteeeerrrraaaattttoooorrrr((((3333CCCC++++++++))))                    RRRRWWWWTTTTPPPPttttrrrrHHHHaaaasssshhhhTTTTaaaabbbblllleeeeIIIItttteeeerrrraaaattttoooorrrr((((3333CCCC++++++++))))
  5.  
  6.  
  7.  
  8. NNNNaaaammmmeeee
  9.      RWTPtrHashTableIterator<T> - Rogue Wave library class
  10.  
  11. SSSSyyyynnnnooooppppssssiiiissss
  12.               #include <rw/tphasht.h>
  13.  
  14.  
  15.  
  16.               RWTPtrHashTable<T> table;
  17.           RWTPtrHashTableIterator<T> iterator(table);
  18.  
  19. PPPPlllleeeeaaaasssseeee NNNNooootttteeee!!!!
  20.      IIIIffff yyyyoooouuuu ddddoooo nnnnooootttt hhhhaaaavvvveeee tttthhhheeee SSSSttttaaaannnnddddaaaarrrrdddd CCCC++++++++ LLLLiiiibbbbrrrraaaarrrryyyy,,,, uuuusssseeee tttthhhheeee iiiinnnntttteeeerrrrffffaaaacccceeee ddddeeeessssccccrrrriiiibbbbeeeedddd
  21.      hhhheeeerrrreeee....  OOOOtttthhhheeeerrrrwwwwiiiisssseeee,,,, uuuusssseeee tttthhhheeee iiiinnnntttteeeerrrrffffaaaacccceeee ttttoooo RRRRWWWWTTTTPPPPttttrrrrHHHHaaaasssshhhhMMMMuuuullllttttiiiiSSSSeeeettttIIIItttteeeerrrraaaattttoooorrrr
  22.      described in the Class Reference.
  23.  
  24.  
  25.  
  26.  
  27.  
  28.  
  29. DDDDeeeessssccccrrrriiiippppttttiiiioooonnnn
  30.      Iterator for class RRRRWWWWTTTTPPPPttttrrrrHHHHaaaasssshhhhTTTTaaaabbbblllleeee<<<<TTTT>>>>,,,, allowing sequential access to all
  31.      the elements of a hash table.  Elements are not accessed in any
  32.      particular order.  Like all Rogue Wave iterators, the "current item" is
  33.      undefined immediately after construction -- you must define it by using
  34.      ooooppppeeeerrrraaaattttoooorrrr(((()))) or some other (valid) operation.  Once the iterator has
  35.      advanced beyond the end of the collection it is no longer valid --
  36.      continuing to use it will bring undefined results.
  37.  
  38. PPPPeeeerrrrssssiiiisssstttteeeennnncccceeee
  39.      None
  40.  
  41. PPPPuuuubbbblllliiiicccc CCCCoooonnnnssssttttrrrruuuuccccttttoooorrrr
  42.               RRRRWWWWTTTTPPPPttttrrrrHHHHaaaasssshhhhTTTTaaaabbbblllleeeeIIIItttteeeerrrraaaattttoooorrrr(RWTPtrHashTable<T>& c);
  43.  
  44.  
  45.      Constructs an iterator to be used with the table cccc.
  46.  
  47.  
  48.  
  49.  
  50.  
  51. PPPPuuuubbbblllliiiicccc OOOOppppeeeerrrraaaattttoooorrrrssss
  52.               RWBoolean
  53.           ooooppppeeeerrrraaaattttoooorrrr++++++++();
  54.  
  55.  
  56.      Advances the iterator to the next item and returns TTTTRRRRUUUUEEEE.  When the end of
  57.      the collection is reached, returns FFFFAAAALLLLSSSSEEEE and the position of the iterator
  58.      will be undefined.
  59.  
  60.  
  61.  
  62.  
  63.                                                                         PPPPaaaaggggeeee 1111
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70. RRRRWWWWTTTTPPPPttttrrrrHHHHaaaasssshhhhTTTTaaaabbbblllleeeeIIIItttteeeerrrraaaattttoooorrrr((((3333CCCC++++++++))))                    RRRRWWWWTTTTPPPPttttrrrrHHHHaaaasssshhhhTTTTaaaabbbblllleeeeIIIItttteeeerrrraaaattttoooorrrr((((3333CCCC++++++++))))
  71.  
  72.  
  73.  
  74.               T*
  75.           ooooppppeeeerrrraaaattttoooorrrr(((())))();
  76.  
  77.  
  78.      Advances the iterator to the next item and returns a pointer to it.  When
  79.      the end of the collection is reached, returns nnnniiiillll and the position of the
  80.      iterator will be undefined.
  81.  
  82. PPPPuuuubbbblllliiiicccc MMMMeeeemmmmbbbbeeeerrrr FFFFuuuunnnnccccttttiiiioooonnnnssss
  83.               RWTPtrHashTable<T>*
  84.           ccccoooonnnnttttaaaaiiiinnnneeeerrrr() const;
  85.  
  86.  
  87.      Returns a pointer to the collection over which this iterator is
  88.      iterating.
  89.  
  90.               T*
  91.           kkkkeeeeyyyy() const;
  92.  
  93.  
  94.      Returns a pointer to the item at the iterator's current position.  The
  95.      results are undefined if the iterator is no longer valid.
  96.  
  97.               void
  98.           rrrreeeesssseeeetttt();
  99.  
  100.  
  101.      Resets the iterator to the state it had immediately after construction.
  102.  
  103.               void
  104.           rrrreeeesssseeeetttt(RWTPtrHashTable<T>& c);
  105.  
  106.  
  107.      Resets the iterator to iterate over the collection cccc.
  108.  
  109.  
  110.  
  111.  
  112.  
  113.  
  114.  
  115.  
  116.  
  117.  
  118.  
  119.  
  120.  
  121.  
  122.  
  123.  
  124.  
  125.  
  126.  
  127.  
  128.  
  129.                                                                         PPPPaaaaggggeeee 2222
  130.  
  131.  
  132.  
  133.